![Introducing Enhanced Alert Actions and Triage Functionality](https://cdn.sanity.io/images/cgdhsj6q/production/fe71306d515f85de6139b46745ea7180362324f0-2530x946.png?w=800&fit=max&auto=format)
Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
@octokit/types
Advanced tools
Package description
The @octokit/types npm package provides TypeScript definitions for GitHub's REST API, GraphQL API, and Webhooks. It is designed to be used with other Octokit libraries to offer type safety and auto-completion in code editors, making it easier to work with GitHub's APIs in a TypeScript project.
GitHub REST API Types
Provides types for responses from GitHub's REST API endpoints. This example shows how to type an object representing a GitHub issue as it would be returned from the REST API.
import { RestEndpointMethodTypes } from '@octokit/types';
const issue: RestEndpointMethodTypes['issues']['get']['response']['data'] = {
id: 1,
number: 1347,
title: 'Just a test issue'
};
GitHub GraphQL API Types
Provides types for constructing and receiving responses from GitHub's GraphQL API. This example demonstrates fetching a repository's details using GraphQL and typing the response.
import { graphql } from '@octokit/graphql';
import { Repository } from '@octokit/types';
async function getRepository(owner: string, name: string): Promise<Repository> {
const { repository } = await graphql<{ repository: Repository }>(
`{
repository(owner: "${owner}", name: "${name}") {
id
name
owner {
login
}
}
}`
);
return repository;
}
GitHub Webhooks Types
Includes types for GitHub Webhook events. This example shows how to handle an incoming webhook event with type safety, specifically for an issue event.
import { WebhookEvent } from '@octokit/types';
function handleWebhook(event: WebhookEvent) {
if (event.name === 'issues') {
const action = event.payload.action;
console.log(`Issue action: ${action}`);
}
}
Provides a simpler, high-level interface specifically for GitHub's GraphQL API, similar to @octokit/types but focused solely on GraphQL. It does not include types for REST API or Webhooks.
A comprehensive GitHub REST API client for JavaScript. It includes TypeScript definitions similar to those in @octokit/types but is bundled with functionality to make API requests, unlike @octokit/types which only provides types.
A library for handling GitHub Webhooks. Similar to @octokit/types, it provides types for webhook events but also includes functionality to verify and parse webhook payloads.
Readme
Shared TypeScript definitions for Octokit projects
See all exported types at https://octokit.github.io/types.ts
import { Endpoints } from "@octokit/types";
type listUserReposParameters =
Endpoints["GET /repos/{owner}/{repo}"]["parameters"];
type listUserReposResponse = Endpoints["GET /repos/{owner}/{repo}"]["response"];
async function listRepos(
options: listUserReposParameters
): listUserReposResponse["data"] {
// ...
}
import {
GetResponseTypeFromEndpointMethod,
GetResponseDataTypeFromEndpointMethod,
} from "@octokit/types";
import { Octokit } from "@octokit/rest";
const octokit = new Octokit();
type CreateLabelResponseType = GetResponseTypeFromEndpointMethod<
typeof octokit.issues.createLabel
>;
type CreateLabelResponseDataType = GetResponseDataTypeFromEndpointMethod<
typeof octokit.issues.createLabel
>;
See CONTRIBUTING.md
FAQs
Shared TypeScript definitions for Octokit projects
The npm package @octokit/types receives a total of 13,859,475 weekly downloads. As such, @octokit/types popularity was classified as popular.
We found that @octokit/types demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.